Assurance Diagnostics API
API Methods
The following methods are supported via this API:
DLMForceProfile
The DLMForceProfile method should be used to change the line profile (DLM operations will continue as normal afterwards). The line must already exist in DLM. This method applies the profile change requested in real-time
DLMOverrideProfile
The DLMOverrideProfile method should be used to change the line profile (DLM operations will cease after this operation). The line must already exist in DLM. This method applies the profile change requested in real-time
GetAuthenticationLogs
The GetAuthenticationLogs method can be used to get a list of authentication logs by CustomerIdentifiier (CASR)
GetAuthenticationStatus
The GetAuthenticationStatus method can be used to get current authentication status by CustomerIdentifiier (CASR)
GetCredentials
The GetCredentials method should be used to retrieve the authentication details for a subscriber
GetDataConnection
The GetDataConnection method can be used to get current session status data by CustomerIdentifiier (CASR)
GetDataUsageHistories
The GetDataUsageHistories method can be used to get usage data by CustomerIdentifiier (CASR)
GetExchangeDetails
GetFibreServiceTestHistory
GetJDSUTestHistory
The GetJDSUTestHistory method will return an array of JDSU results for the specified customer
GetJDSUTestResults
The GetJDSUTestResults method should be used to request the test Results of an executed test for a given subscriber
GetJDSUTestStatus
The GetJDSUTestStatus method should be used to request the latest test status for a given subscriber for in-flight tests
GetLastCompletedTAMTestResult
The GetLastCompletedTAMTestResult method should be used to request the last completed TAM test result for a given subscriber
GetLatestFibreServiceTestResult
The GetLatestServiceTestResult method will return the results of a Fibre Service Test
GetLatestTAMTestResult
The GetLatestTAMTestResult method should be used to request the latest TAM test results for a given subscriber, including in-flight tests
GetLineData
The GetLineData method should be used to retrieve the history of a line. Only data will be returned for the last seven days at most. This method returns historical and not real-time data
GetPOSSpeedRange
The GetPOSSpeedRange method can be used to get recorded point of sale speed data by CustomerIdentifiier(CASR). There can be more than one recorded POS speeds as the recontract scenario
GetProfileHistory
The GetProfileHistory method should be used to retrieve the history of a profile for a line as controlled by DLM. The data will only be returned for the last 30 days at most
GetServiceStatus
The GetServiceStates method can be used to get service status data by CustomerIdentifiier (CASR)
GetSpeedTestResults
The GetSpeedTestResults method should be used to retrieve a list of the most recent speed test results for a line submitted at https://www.supportal-test.co.uk/
GetSTBDeviceDetails
GetSubscriberIPAddress
The GetSubscriberIPAddress method will return the IP address of the specified subscriber, if one is available/the subscriber is connected
GetSyncStatus
GetTAMTestHistory
The GetTAMTestHistory method will return an array of TAM Test results for the specified customer
GetValidLineProfiles
The GetValidLineProfiles method should be used to retrieve a list of all the valid profile names available for the algorithm the line is currently associated with
IssueFibreServiceTestRequest
The IssueFibreServiceTestRequest method will initiate a new Fibre Service Test for the specified customer
IssueMetascriptTest
The IssueMetascriptTest method should be used to request a JDSU Metascript test on a subscriber’s line
IssueTAMTest
The IssueTAMTest method should be used to request a TAM test on a subscriber’s line
ProvideSpeedTestResults
The ProvideSpeedTestResults method can be used to provide the most recent speed test results for the specified line
ResetBroadband
The ResetBroadbandSession method function will ‘bounce’ a user’s session i.e. cause a full clear of the session and therefore the current RADIUS attributes on the BRAS followed by
reestablishment of the user’s session
ResetPort
The ResetPort method function will cycle the MSAN port in the serving exchange and cause a full clear of the session and therefore the current RADIUS attributes on the BRAS followed by
reestablishment of the user’s session
SearchAuthenticationLogs
The SearchAuthenticationLogs method returns the available logs from the radius platforms for a given subscriber. Data is returned for the last 21 days but is limited to the fifty newest records per radius database